OpenBuildings™ Designer Help

Family/Part Editor

Used to view, create, and manage families of parts, compound parts, and components in a Building dataset.

Accessed from:
  • Backstage: File > Dataset Tools > Family/Part
  • Apply Part dialog:


Note: Building datasets include a set of directories that contain intelligent data in the form of parts, compound parts, and components. These element definitions are stored in *.xml files. The XML files should never be edited directly. Family/Part Editor should be used to edit parts, compound parts and components.
Use the Family/Part Editor to:
  • View detailed information on all parts, compound parts, and components in the dataset.
  • Edit the definitions of parts, compound parts, and components.
  • Simultaneously edit multiple parts, compound parts, or components.
  • Create new parts, compound parts, and components, and assign them to a family. New families can also be created. It is possible to create new files to further organize the dataset.
  • Manage parts, compound parts, components, and families; and manage their organization. For example, move a part from one family to another.
SettingDescription
Dataset > Commit Changes Commits changes made to the dataset.
Dataset > Refresh Becomes active when the dataset differs from the disk dataset. If the dataset has changed and changes have not been committed, refresh the dataset. An Alert dialog prompts to commit changes to the disk dataset. Click No to discard changes and reload the disk dataset. If the disk dataset has changed, click Refresh, the Dataset Synchronization dialog appears. To load the updated disk dataset, click Refresh on that dialog.
Dataset > Synchronize Synchronizes the dataset with the disk dataset, which has been modified. This selection is available only if the disk dataset has changed from the current view of the data due to an external modification.
Edit > New Creates a new item (file, family, part, compound part, or component). Opens the New File dialog , New Family dialog or a Definition dialog opens. The dialog that appears depends on which item is selected in the left pane of the Family/Part Editor. The New menu item can invoke a dialog for Files, Families, Parts, Compound Parts, and Components.
Edit > Show Active If there is an active part or compound part, this menu item is active. Displays the dialog for the selected view for the active part or compound part.
Edit > Set Active Sets the highlighted part or compound part as the active part, which is ready for placement.
Edit > Cut Cuts the data for the highlighted file, family, part, compound part, or component and places it in the clipboard.
Edit > Copy Copies the data for the highlighted file, family, part, compound part, or component and places it in the clipboard.
Edit > Paste Pastes the contents of the buffer into the active window. This command is active only if the paste operation is allowable (for example, if data for a part is in the clipboard, and the active window is for parts). Data cannot be "mixed", such as pasting a compound part into a part window.
Edit > Show Clipboard Shows the data that was copied and placed into the clipboard.
Edit > Delete Deletes the selected item from the family. If delete rather than cut, the data for the part, compound part, or component is not added to the clipboard and therefore is not available for a paste operation.
Edit > Rename Renames the selected file, family, part, compound part, or component.
Edit > Select All Selects all items in the active window.
Edit > Clear All Clears all selected items in the active window.
Edit > Invert Selection Inverts the selected items in the active window.
Edit > Properties Displays the dialog for the selected item for the selected view. If have a part selected and the view is Drawing Notation, then the Drawing Notation dialog appears and can be edited.
Show Active (also Edit > Show Active) — If there is an active part or compound part, this menu item is active. Displays the dialog for the selected view for the active part or compound part.
Set Active (also Edit > Set Active) — Sets the highlighted part or compound part as the active part, which is ready for placement.
Commit Changes (also Dataset > Commit Changes) — Commits the changes have made to the dataset.
Refresh Dataset (also Dataset > Refresh) — Becomes active if the dataset differs from the disk dataset. If the dataset has changed and changes have not been committed, refresh the dataset. An Alert dialog prompts to commit changes to the disk dataset. Clicking No to discard changes and reload the disk dataset. If the disk dataset has changed and click Refresh, then the Dataset Synchronization dialog appears. To load the updated disk dataset, click Refresh on that dialog.
Synchronize Dataset (also Dataset > Synchronize) — Synchronizes the dataset with the disk dataset, which has been modified. This selection is available only if the disk dataset has changed from the current view of the data due to an external modification.
(Parts; Compound Parts; Component) View

Located just to the right of the Family/Part Editor toolbar, this menu enables when a family is selected in directory tree. If the family contains parts, the View option menu is labeled Parts View. If the family contains compound parts or components, the View option menu is labeled Compound Parts View and Components View respectively.

Each option opens a dialog containing various settings that control option properties for the corresponding part, compound part, or component.

To open a View option dialog:
  1. Select one of the View options
  2. Right-click in the properties list box to open a pop-up menu
  3. Select Properties
View options Description
Definition, Part | Compound Part | Component Display settings on the Definition dialog. These fields specify the name, description and default model attributes.
Drawing Symbology (part only) Displays the fields found on the Drawing Symbology dialog. These fields specify the cut plane view symbology and the forward and reflected view symbologies (for extracted drawings), and whether or not to use them.
Cut Patterns (part only) Displays the fields found on the Cut Patterns Properties dialog. These fields specify the pattern to use for a cut view, including hatching or patterning (for extracted drawings), and whether or not to use them.
Centerline Symbology (part only) Displays the fields found on the Centerline Symbology dialog. These fields specify the center line symbology, and whether or not to use it.
Rendering Properties (part only) Displays the fields found on the Rendering Properties dialog. These fields specify the rendering palette and material, a preview, and whether or not to use this symbology.
Report Components (part only) Displays the fields found on the Report Components dialog. These fields specify the family, name, and formula to apply to the element for a report.
Drawing Notation (part only) Displays the fields found on the Drawing Notation dialog. These fields display the user-specified notations to place on an extracted drawing.
Variable Prices (component only) Displays the fields found on the Variable Prices dialog. These fields specify if a variable prices control is in use; what the high, medium, and low prices are; the unit price, and the quantities.
Specification Texts (component only) Displays the fields found on the Specification Texts dialog. These fields specify the external text files to use for the specifications on this component.
Analytical Material(part only) Contains controls for applying energy analysis data to part definitions.
Structural (part only) Displays the fields found on the Structural dialog. These controls define the physical characteristics of a structural member.
Model preview Displays the model symbology of the selected part.
Section preview Displays the section symbology of the selected part.
F/R View (Forward/Reflected) preview Displays the forward/reflected view symbology of the selected part.
Material preview Displays the material symbology of the selected part.
Directory Tree (left pane) Displays Categories of dataset information in a directory tree format. Currently, there are three categories of dataset information: Parts; Compound Parts; and Components.

When All Parts (or All Compound Parts, or All Components) is selected in the directory, all parts for the dataset display in the property list (right pane) and the properties and symbology for all parts display as well. Select one or any number of the parts in the properties list box, and changes can be made to all of them at the same time. For example, to change the center line property for several parts, select All Parts in the directory (multiple parts can be chosen in the property list box by holding down <Ctrl>). Changes can then be made simultaneously at the same time.

When selecting any category By Families, the category directory tree expands to show the text file (*.xml) where family data is stored. When a file is selected in the directory, the families within that file are displayed in the properties list box.

Properties (right pane) Displays the attributes and properties of individual parts, compound parts, and components. When selecting a category in the directory tree (left pane), all elements and properties for that category display in the property list (right pane). Properties can be selected for change. Simply right-click the field and choose Properties from the option menu to complete changes.

Another way to complete part changes is to select the part and select Edit > Properties. This action opens the (Edit) Definition dialog for the selected part. Changes to all part properties can be made in this dialog.

Regarding the mode-less capability of the Family/Part Editor dialog – when browsing the dataset, it is recommended to open the Properties dialog and leave it open until browsing is completed. When the selection changes in the properties list, the display updates to the current selection while the Properties dialog continues to remain open.

Tip: This is very useful as some views contain so many properties that it can be difficult to assimilate all information by looking only at the properties list. The Properties dialogs organize properties so that they are easier to understand.

Note: Individual property field changes can be made in the Family/Part Editor dialog without dismissing an open Definitions dialog.
Note: It is possible to review properties for parts and components at the same time, however the OK and Apply buttons disable when this occurs to prevent you from accidentally updating part data with component data.
Tip: You can change the display of columns in the properties list box with a right-click on any column header and choosing List. Any set of columns can be used in a view and columns do not necessarily have to be associated with any particular view by default. Family/Part Editor remembers the columns chosen, for the next design session.

Key-ins

To Use
Open the Family/Part Editor dialog.
MDL LOAD TFDSEXPLORER
Restore the property list columns to default configuration
TFDSEXPLORER SETTINGS DEFAULT
Separate Component | Part | Compound Part families into individual XML files and create a back-up of the original XML files.
TFDATASET < COMP | PART | CPART | | | > SEPARATEFAM
Refresh the active dataset and update part, compound part, and settings XML files.
TFDATASET REFRESH
Validate existing levels for all parts in the active dataset.
TFDATASET VALIDATEPARTSLEVELS